Get Primary Key values for Records in Query
Description
Execute a query and then retrieve the primary key values for the parent table of a Data Bound UX component. (IMPORTANT: This action is intended for an event on a UX component).
Used with the UX component.
Table Filter/Order Properties
- Maximum number of keys to load
Specify the maximum number of keys to load. If you try to load to many keys, you will slow down the performance of your application.
- Method for specifying filter/order
Method for specifying filter/order property. Choices include SpecifyNow, ComputeFromSubmittedValues.
- Filter
Specify the filter expression.
- Filter arguments
If you specify a filter using arguments, (e.g. customerId = :whatId) specify the explicit values for each argument.
- Order
Specify the order expression.
- Define search fields
Specify the controls on the Dialog that will be used to compute the Filter to apply to the table. Key values for all of the records in the filtered table will be retrieved.
- Combine criteria using
If the user enters more than one search criterion, combine using AND or OR Choices include AND, OR.
- Keyword search
Specify if the search is a 'keyword' style search. For a 'keyword' search, there is a single control where the user types a value to search for, and the search is performed in multiple fields. For example, the user might enter a search value of 'smi', and the search would be performed in the Firstname, Lastname, Address, City, and State fields.
- Search input field
Specify the name of the control into which the user will entry the search value. If you want to call a Javascript function to return the search value, specify: Javascript_<functionName> where 'functionName' is the name of the Javascript functin you want to call. For example: javascript_myfunc
- Keyword search fields
Specify the fields in the List that should be searched.
- Define sort fields
Specify the controls on the Dialog that will be used to compute the Order to apply to the table. Key values will be retrieved in the specified order.
- Base filter
(Optional) You can specify a 'base filter' that is applied in addition to the filter that the user defined. This is useful if you want the user to only be able to search within a certain set of records.
No Records in Query Options Properties
- No records found action
If the user enters search criteria that find no record what action should be taken? You can either show all records, show an empty record for the user to add a new record, or do nothing. Choices include ShowAllRecords, ShowNewRecord, DoNothing.
- Message to display (ShowAll Option)
Specify the message to show if no records were found. If you want to suppress the message, enter <None>. You can use language tags (<a5:r>..</a5:r>) in the message.
- Message to display (NewRecord Option)
Specify the message to show if no records were found. If you want to suppress the message, enter <None>. You can use language tags (<a5:r>..</a5:r>) in the message.
Key Description Fields Properties
- Include additional fields to describe the Primary Key
Should additional fields be retrieved for each key value to describe the key. For example, you might want to retrieve the 'AccountName' field for each 'AccountId'. This would only be necessary if you were displaying the key list in a List View control, for example.
- Define additional fields
Define additional fields property.
Client-side Events Properties
- Before search
Specify the name of the Javascript function to call before the search is submitted to the server. If the function returns false, the search is not performed.
- After search
Specify the name of the Javascript function to call after the search has completed. The function takes 'e' as an argument. e.recordsInQuery contains the number of records in the query.
Slider Control Properties
- Has slider control to select active record
Specify if the UX Component should show a slider control to select the current record.
- Slider Placeholder ID
Specify the ID of the Placeholder Control in which the slider should be shown.
- Show slider message
Specify if a message should be shown when the user is dragging on the slider.
- Slider message
Specify the message that should be shown when the user is dragging on the slider. The message can use HTML markup. You can use these placeholders in the template: {PrimaryKeyDescription}, {recordNumber} and {recordcount}
- Slider width
Specify the slider width. Use CSS syntax. E.g. 300px, 4in, etc. TIP: You may also need to set the width of the placeholder control. For example, if you set the width to 100%, you will also need to set the width of the slider placeholder to 100%.
- Slider message prefix
Specify the prefix to show in front of the slider message. The text can include HTML markup.
- New record message
Specify the message to show when the user navigates to a new record. The message can use HTML markup.
- No records message
Specify the message to show when there are no records in the query. The message can use HTML markup.
- Hide slider message when focus lost
Should the slider message fade from view when the mouse is no longer over the slider.
- Slider message position
Specify where the slider message should be positioned relative to the slider. Choices include Above, Below.
- (Optional) Client-side onSlide event handler
(Optional) You can specify the name of a Javascript function to call when the user moves the slider. Your function will take 3 parameters: 'CurrentKeyDescription' - the description of the current key value, 'Value' - the slider index, and 'Count' - the maximum index of the slider.
- (Optional) Client-side onChange event handler
(Optional) You can specify the name of a Javascript function to call when the user moves the slider to a new position. Your function will take 3 parameters: 'CurrentKeyDescription' - the description of the current key value, 'Value' - the slider index, and 'Count' - the maximum index of the slider.
List View Properties
- Has list view of records to select active record
Specify if the UX Component should show a list view control showing all of the primary keys in the current query. The user can click in the list view control to select the active record.
- List View Placeholder ID
Specify the ID of the Placeholder Control in which the List View should be shown.
- Height
Specify the height of the List View control. Use CSS syntax. E.g. 4in, 200px, etc.
- Width
Specify the width of the List View control in inches.
- Loading data message
Specify the message to show in the List View control while data is being loaded. You can use language tags in the string (e.g. <a5:r>text</a5:r>)
- Has free-form template
Specify if the data in the List View control is laid out using a free-form template.
- Free-form template
Define the free-form template.
- Column heading
Define the column heading for List-View. This property is only used when free-form template is turned on.
Custom List View Record Navigators Properties
- Has custom List View record navigators
Specify if the UX component has any custom List View controls that should be used to navigate the record that has focus.
- List View ids
Specify the ids of the custom List View controls that should be used as record navigators.
Javascript Properties
- onSelect
Specify Javascript to execute when the user clicks on an item in the List View control.
Panel Options Properties
- Fill panel container
(Applies only when List View is in a Panel Card.) Should the List expand to consume all of the space in the Panel Card?
- Target panel onSelect
(Applies only when List View is in a Panel Card that is inside a Panel Navigator.) When the user clicks on an item in the List View specify the name of the Panel Card that should get focus. You can also specify <None> or <NextPanel>.
Debugging Properties
- Show computed query
Show the query computed from the submitted data.
- Element id
Specify the ID of the element on the Dialog where the computed query should be shown.
See Also